Inscoper::DeviceDescription¶

DeviceDescription class provides device information coming from drivers. More...

#include <DeviceDescription.h>

Public Functions¶

	Name
	DeviceDescription() Default constructor.
const std::string &	getDescription() const Get the description of the device.
void	setDescription(const std::string & description) Set the description of the device.
const std::string &	getVersion() const Get the version of the device driver.
void	setVersion(const std::string & version) Set the version of the device driver.
const std::string &	getBrand() const Get the brand of the device.
void	setBrand(const std::string & brand) Set the brand of the device.
const std::string &	getModel() const Get the model of the device.
void	setModel(const std::string & model) Set the model of the device.
const std::string &	getReleaseDate() const Get the release date of the device driver.
void	setReleaseDate(const std::string & releaseDate) Set the release date of the device driver.
const std::string &	getAuthor() const Get the author of the device driver.
void	setAuthor(const std::string & author) Set the author of the device driver.
const std::string &	getChangeLog() const Get the change log of the device driver.
void	setChangeLog(const std::string & changeLog) Set the change log of the device driver.
const std::string &	getFxmlContent() const Get the fxml content of the device driver.
void	setFxmlContent(const std::string & fxmlContent) Set the fxml content of the device driver.
Inscoper::EDriverType	getDriverType() const Get the driver type of the device.
Inscoper::NBO::ENBOType	getNBOType() const get the nbo type of the device
void	setNBOType(Inscoper::NBO::ENBOType nboType) set the nbo type of the device
bool	isInitialized() const Return whether the device is initialized or not.
void	setInitialized(bool initialized) Set the status of the initialization of the device.
void	addSubDeviceDescription(const Inscoper::SubDeviceDescriptionPtr & subDeviceDescription) Add a sub-device description to the device.
std::vector< Inscoper::SubDeviceDescriptionPtr >	getSubDeviceDescriptionList() const Get all sub-device descriptions across all groups.
Inscoper::SubDeviceDescriptionPtr	getSubDeviceDescription(unsigned short subDeviceTag) Get the description corresponding to the given tag.
void	addParamsDescription(const Inscoper::ParamDescriptionPtr & paramsDescription) Add a parameter description to the device.
Inscoper::ParamDescriptionPtr	getParamsDescription(unsigned short paramTag) Get the parameter description by tag.
const std::vector< Inscoper::ParamDescriptionPtr > &	getParamsDescriptionList() const Get the list of parameter descriptions.
void	setParamDescriptionList(const std::vector< Inscoper::ParamDescriptionPtr > & paramDescriptionList) Set the list of parameter descriptions.
const Inscoper::DriverDescriptionPtr &	getDriverDescription() const Get the driver description.
void	setDriverDescription(const Inscoper::DriverDescriptionPtr & driverDescription) Set the driver description.
void	addSubDeviceGroupDescription(const Inscoper::SubDeviceGroupDescriptionPtr & subDeviceGroupDescription) Set a description to the device.
const std::vector< Inscoper::SubDeviceGroupDescriptionPtr > &	getSubDeviceGroupDescriptionList() const get the Sub Device Group Description list
void	setSubDeviceGroupDescriptionList(const std::vector< Inscoper::SubDeviceGroupDescriptionPtr > & subDeviceGroupDescriptionList) set the Sub Device Group Description list
Inscoper::SubDeviceGroupDescriptionPtr	getSubDeviceGroupDescription(unsigned short groupTag) get the Sub Device Group Description corresponding to the given tag

Detailed Description¶

class Inscoper::DeviceDescription;

DeviceDescription class provides device information coming from drivers.

This class holds comprehensive information about a device as reported by its driver, including version, brand, model, author, change log, and associated sub-devices and parameters.

Public Functions Documentation¶

function DeviceDescription¶

DeviceDescription()

Default constructor.

Initializes a new instance of the DeviceDescription class.

function getDescription¶

const std::string & getDescription() const

Get the description of the device.

Return: The description of the device

Retrieves the textual description of the device.

function setDescription¶

void setDescription(
    const std::string & description
)

Set the description of the device.

Parameters:

description : The description of the device

Sets the textual description of the device.

function getVersion¶

const std::string & getVersion() const

Get the version of the device driver.

Return: The version of the device driver

Retrieves the version of the device driver.

function setVersion¶

void setVersion(
    const std::string & version
)

Set the version of the device driver.

Parameters:

version : The version of the device driver

Sets the version of the device driver.

function getBrand¶

const std::string & getBrand() const

Get the brand of the device.

Return: The brand of the device

Retrieves the brand name of the device.

function setBrand¶

void setBrand(
    const std::string & brand
)

Set the brand of the device.

Parameters:

brand : The brand of the device

Sets the brand name of the device.

function getModel¶

const std::string & getModel() const

Get the model of the device.

Return: The model of the device

Retrieves the model name of the device.

function setModel¶

void setModel(
    const std::string & model
)

Set the model of the device.

Parameters:

model : The model of the device

Sets the model name of the device.

function getReleaseDate¶

const std::string & getReleaseDate() const

Get the release date of the device driver.

Return: The release date of the device driver

Retrieves the release date of the device driver.

function setReleaseDate¶

void setReleaseDate(
    const std::string & releaseDate
)

Set the release date of the device driver.

Parameters:

releaseDate : The release date of the device driver

Sets the release date of the device driver.

function getAuthor¶

const std::string & getAuthor() const

Get the author of the device driver.

Return: The author of the device driver

Retrieves the author of the device driver.

function setAuthor¶

void setAuthor(
    const std::string & author
)

Set the author of the device driver.

Parameters:

author : The author of the device driver

Sets the author of the device driver.

function getChangeLog¶

const std::string & getChangeLog() const

Get the change log of the device driver.

Return: The change log of the device driver

Retrieves the change log history of the device driver.

function setChangeLog¶

void setChangeLog(
    const std::string & changeLog
)

Set the change log of the device driver.

Parameters:

changeLog : The change log of the device driver

Sets the change log history of the device driver.

function getFxmlContent¶

const std::string & getFxmlContent() const

Get the fxml content of the device driver.

Return: The fxml content of the device driver

Retrieves the fxml content of the device driver.

function setFxmlContent¶

void setFxmlContent(
    const std::string & fxmlContent
)

Set the fxml content of the device driver.

Parameters:

fxmlContent : The fxml content of the device driver

Sets the fxml content of the device driver.

function getDriverType¶

Inscoper::EDriverType getDriverType() const

Get the driver type of the device.

Return: The driver type of the device

Retrieves the type of driver controlling this device.

function getNBOType¶

Inscoper::NBO::ENBOType getNBOType() const

get the nbo type of the device

Return: the nbo type of the device

function setNBOType¶

void setNBOType(
    Inscoper::NBO::ENBOType nboType
)

set the nbo type of the device

Parameters:

nboType : the nbo type of the device

function isInitialized¶

bool isInitialized() const

Return whether the device is initialized or not.

Return: True if the device is initialized, false otherwise

Checks if the device has been successfully initialized.

function setInitialized¶

void setInitialized(
    bool initialized
)

Set the status of the initialization of the device.

Parameters:

initialized : True if the device must be initialized

Updates the initialization status of the device.

function addSubDeviceDescription¶

void addSubDeviceDescription(
    const Inscoper::SubDeviceDescriptionPtr & subDeviceDescription
)

Add a sub-device description to the device.

Parameters:

subDeviceDescription : the description to add

Adds the sub-device description into a default "Others" group. If the group does not exist yet, it is created automatically.

function getSubDeviceDescriptionList¶

std::vector< Inscoper::SubDeviceDescriptionPtr > getSubDeviceDescriptionList() const

Get all sub-device descriptions across all groups.

Return: A concatenated list of all sub-device descriptions

Aggregates and returns the sub-device descriptions from every SubDeviceGroupDescription attached to this device.

function getSubDeviceDescription¶

Inscoper::SubDeviceDescriptionPtr getSubDeviceDescription(
    unsigned short subDeviceTag
)

Get the description corresponding to the given tag.

Parameters:

subDeviceTag : The tag

Return: The description if found, nullptr otherwise

Retrieves the sub-device description corresponding to the given tag.

function addParamsDescription¶

void addParamsDescription(
    const Inscoper::ParamDescriptionPtr & paramsDescription
)

Add a parameter description to the device.

Parameters:

paramsDescription : The parameter description to add

Appends a parameter description to the device's list of parameter descriptions.

function getParamsDescription¶

Inscoper::ParamDescriptionPtr getParamsDescription(
    unsigned short paramTag
)

Get the parameter description by tag.

Parameters:

paramTag : The tag of the parameter description

Return: The parameter description if found, nullptr otherwise

Retrieves the parameter description corresponding to the given tag.

function getParamsDescriptionList¶

const std::vector< Inscoper::ParamDescriptionPtr > & getParamsDescriptionList() const

Get the list of parameter descriptions.

Return: The list of parameter descriptions

Retrieves the list of parameter descriptions associated with this device.

function setParamDescriptionList¶

void setParamDescriptionList(
    const std::vector< Inscoper::ParamDescriptionPtr > & paramDescriptionList
)

Set the list of parameter descriptions.

Parameters:

paramDescriptionList : The new list of parameter descriptions

Replaces the current list of parameter descriptions with a new one.

function getDriverDescription¶

const Inscoper::DriverDescriptionPtr & getDriverDescription() const

Get the driver description.

Return: The driver description

Retrieves the description of the driver associated with this device.

function setDriverDescription¶

void setDriverDescription(
    const Inscoper::DriverDescriptionPtr & driverDescription
)

Set the driver description.

Parameters:

driverDescription : The driver description

Sets the description of the driver associated with this device.

function addSubDeviceGroupDescription¶

void addSubDeviceGroupDescription(
    const Inscoper::SubDeviceGroupDescriptionPtr & subDeviceGroupDescription
)

Set a description to the device.

Parameters:

subDeviceGroupDescription : the Sub Device Group Description to add

function getSubDeviceGroupDescriptionList¶

const std::vector< Inscoper::SubDeviceGroupDescriptionPtr > & getSubDeviceGroupDescriptionList() const

get the Sub Device Group Description list

Return: the Sub Device Group Description list

function setSubDeviceGroupDescriptionList¶

void setSubDeviceGroupDescriptionList(
    const std::vector< Inscoper::SubDeviceGroupDescriptionPtr > & subDeviceGroupDescriptionList
)

set the Sub Device Group Description list

Parameters:

subDeviceGroupDescriptionList : the Sub Device Group Description list

function getSubDeviceGroupDescription¶

Inscoper::SubDeviceGroupDescriptionPtr getSubDeviceGroupDescription(
    unsigned short groupTag
)

get the Sub Device Group Description corresponding to the given tag

Parameters:

groupTag : the Sub Device Group Description's tag

Return: : the Sub Device Group Description if found or nullptr

Updated on 2026-06-23 at 10:35:19 +0200